Get a list of closure request

GET /api/v1/Accounts/closure-request/get-all

Description

This endpoint allows you to retrieve a list of closure requests for accounts based on various parameters such as reason, status, and search text.

Request

• Path parameter:

  • version: API version (string)

• Query parameters:

  • RequestReason: Account closure reason (string)

  • RequestStatus: Account closure status (string)

  • Orderby: Order by which the closure requests should be listed (string)

  • SearchText: Search text for filtering closure requests (string, nullable)

  • Descending: Sort in descending order if true, ascending order otherwise (boolean, nullable)

  • PageNumber: Page number for pagination (integer, int32)

  • PageSize: Number of items per page (integer, int32)

• Headers:

  • Accept-Language: Change default response message language from English(en). Available languages fr,en

Responses

• 200: Success. Returns an AccountClosureResponseListPagedResponse.

• 400: Bad Request. The request is not valid.

Examples

Request

HTTP

httpCopy codeGET /api/v{version}/Accounts/closure-request/get-all?RequestReason={reason}&RequestStatus={status}&Orderby={orderby}&SearchText={searchtext}&Descending={descending}&PageNumber={pagenumber}&PageSize={pagesize} HTTP/1.1
Host: example.com
Accept-Language: en

Response

JSON

jsonCopy codeHTTP/1.1 200 OK
{
  "closureRequests": [
    {
      "id": "{id1}",
      "reason": "{reason1}",
      "status": "{status1}"
    },
    {
      "id": "{id2}",
      "reason": "{reason2}",
      "status": "{status2}"
    }
  ],
  "totalPages": 10,
  "currentPage": 1,
  "pageSize": 2
}

/api/v`{{version}}`/Accounts/closure-request/get-all?RequestReason=1&RequestStatus=3&Orderby=1&SearchText=<string>&Descending=<boolean>&PageNumber=<integer>&PageSize=<integer>

Headers

Content-Type	Value
Accept-Language

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
RequestReason	1
RequestStatus	3
Orderby	1
SearchText	<string>
Descending	<boolean>
PageNumber	<integer>
PageSize	<integer>

Response: 200

{
  "pageNumber": `<integer>`,
  "pageSize": `<integer>`,
  "total": `<integer>`,
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": [
    {
      "id": `<uuid>`,
      "requestedBy": `<string>`,
      "requestDate": `<dateTime>`,
      "lastModifiedBy": `<string>`,
      "modifiedDate": `<dateTime>`,
      "accountId": `<string>`,
      "closureReason": `<string>`,
      "requestStatus": `<string>`
    },
    {
      "id": `<uuid>`,
      "requestedBy": `<string>`,
      "requestDate": `<dateTime>`,
      "lastModifiedBy": `<string>`,
      "modifiedDate": `<dateTime>`,
      "accountId": `<string>`,
      "closureReason": `<string>`,
      "requestStatus": `<string>`
    }
  ]
}

Response: 400

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": `<string>`
}